Port the site documentation from APT to Markdown - #242
Merged
Conversation
Kept as its own commit so that git log --follow and git blame still reach the page's history once the content changes.
The page keeps its .vm suffix: it interpolates ${project.scm.tag} into a link to
the sample in the source tree, so Velocity still has work to do.
Velocity reads ## as a line comment, which would silently delete every heading
below level one before Doxia sees the page, so level two uses a setext underline
and the level three heading is wrapped in an unparsed block.
Verified by building the site before and after and comparing every generated page:
the meta tags, title, headings, visible text and every link target are identical.
The only change is the 'edit this page' link, which now points at the new path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The last APT page in this component, converted to Markdown.
The page keeps its
.vmsuffix: it interpolates${project.scm.tag}into a link to the sample in the source tree, so Velocity still has work to do.Velocity reads
##as a line comment, so every heading below level one would be silently deleted before Doxia sees the page. Level two uses a setext underline and the level three heading is wrapped in an unparsed#[[ ]]#block, which is plain Velocity and needs no Doxia change.Two commits: a pure
git mvso thatgit log --followandgit blamestill reach the page history, then the conversion. Please merge or rebase rather than squash — squashing collapses the rename.Verified by building the site before and after and comparing all 16 generated pages: the author and date meta tags, the title, the headings, the visible text and every link target are identical. The one change is the "edit this page" link, which now points at the new path.